3 namespace MediaWiki\Tests\Revision
;
8 use MediaWiki\Revision\RevisionRenderer
;
9 use MediaWiki\Storage\MutableRevisionRecord
;
10 use MediaWiki\Storage\RevisionRecord
;
11 use MediaWiki\User\UserIdentityValue
;
12 use MediaWikiTestCase
;
15 use PHPUnit\Framework\MockObject\MockObject
;
18 use Wikimedia\Rdbms\IDatabase
;
19 use Wikimedia\Rdbms\ILoadBalancer
;
23 * @covers \MediaWiki\Revision\RevisionRenderer
25 class RevisionRendererTest
extends MediaWikiTestCase
{
32 private function getMockTitle( $articleId, $revisionId ) {
33 /** @var Title|MockObject $mock */
34 $mock = $this->getMockBuilder( Title
::class )
35 ->disableOriginalConstructor()
37 $mock->expects( $this->any() )
38 ->method( 'getNamespace' )
39 ->will( $this->returnValue( NS_MAIN
) );
40 $mock->expects( $this->any() )
42 ->will( $this->returnValue( __CLASS__
) );
43 $mock->expects( $this->any() )
44 ->method( 'getPrefixedText' )
45 ->will( $this->returnValue( __CLASS__
) );
46 $mock->expects( $this->any() )
47 ->method( 'getDBkey' )
48 ->will( $this->returnValue( __CLASS__
) );
49 $mock->expects( $this->any() )
50 ->method( 'getArticleID' )
51 ->will( $this->returnValue( $articleId ) );
52 $mock->expects( $this->any() )
53 ->method( 'getLatestRevId' )
54 ->will( $this->returnValue( $revisionId ) );
55 $mock->expects( $this->any() )
56 ->method( 'getContentModel' )
57 ->will( $this->returnValue( CONTENT_MODEL_WIKITEXT
) );
58 $mock->expects( $this->any() )
59 ->method( 'getPageLanguage' )
60 ->will( $this->returnValue( Language
::factory( 'en' ) ) );
61 $mock->expects( $this->any() )
62 ->method( 'isContentPage' )
63 ->will( $this->returnValue( true ) );
64 $mock->expects( $this->any() )
67 function ( Title
$other ) use ( $mock ) {
68 return $mock->getArticleID() === $other->getArticleID();
71 $mock->expects( $this->any() )
74 function ( $perm, User
$user ) use ( $mock ) {
75 return $user->isAllowed( $perm );
84 * @param int $linkCount
88 private function getMockDatabaseConnection( $maxRev = 100, $linkCount = 0 ) {
89 /** @var IDatabase|MockObject $db */
90 $db = $this->getMock( IDatabase
::class );
91 $db->method( 'selectField' )
93 function ( $table, $fields, $cond ) use ( $maxRev, $linkCount ) {
94 return $this->selectFieldCallback(
108 * @return RevisionRenderer
110 private function newRevisionRenderer( $maxRev = 100, $useMaster = false ) {
111 $dbIndex = $useMaster ? DB_MASTER
: DB_REPLICA
;
113 $db = $this->getMockDatabaseConnection( $maxRev );
115 /** @var ILoadBalancer|MockObject $lb */
116 $lb = $this->getMock( ILoadBalancer
::class );
117 $lb->method( 'getConnection' )
120 $lb->method( 'getConnectionRef' )
123 $lb->method( 'getLazyConnectionRef' )
127 return new RevisionRenderer( $lb );
130 private function selectFieldCallback( $table, $fields, $cond, $maxRev ) {
131 if ( [ $table, $fields, $cond ] === [ 'revision', 'MAX(rev_id)', [] ] ) {
135 $this->fail( 'Unexpected call to selectField' );
136 throw new LogicException( 'Ooops' ); // Can't happen, make analyzer happy
139 public function testGetRenderedRevision_new() {
140 $renderer = $this->newRevisionRenderer( 100 );
141 $title = $this->getMockTitle( 7, 21 );
143 $rev = new MutableRevisionRecord( $title );
144 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
145 $rev->setTimestamp( '20180101000003' );
148 $text .= "* page:{{PAGENAME}}\n";
149 $text .= "* rev:{{REVISIONID}}\n";
150 $text .= "* user:{{REVISIONUSER}}\n";
151 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
152 $text .= "* [[Link It]]\n";
154 $rev->setContent( 'main', new WikitextContent( $text ) );
156 $options = ParserOptions
::newCanonical( 'canonical' );
157 $rr = $renderer->getRenderedRevision( $rev, $options );
159 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
161 $this->assertSame( $rev, $rr->getRevision() );
162 $this->assertSame( $options, $rr->getOptions() );
164 $html = $rr->getRevisionParserOutput()->getText();
166 $this->assertContains( 'page:' . __CLASS__
, $html );
167 $this->assertContains( 'rev:101', $html ); // from speculativeRevIdCallback
168 $this->assertContains( 'user:Frank', $html );
169 $this->assertContains( 'time:20180101000003', $html );
171 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
174 public function testGetRenderedRevision_current() {
175 $renderer = $this->newRevisionRenderer( 100 );
176 $title = $this->getMockTitle( 7, 21 );
178 $rev = new MutableRevisionRecord( $title );
179 $rev->setId( 21 ); // current!
180 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
181 $rev->setTimestamp( '20180101000003' );
184 $text .= "* page:{{PAGENAME}}\n";
185 $text .= "* rev:{{REVISIONID}}\n";
186 $text .= "* user:{{REVISIONUSER}}\n";
187 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
189 $rev->setContent( 'main', new WikitextContent( $text ) );
191 $options = ParserOptions
::newCanonical( 'canonical' );
192 $rr = $renderer->getRenderedRevision( $rev, $options );
194 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
196 $this->assertSame( $rev, $rr->getRevision() );
197 $this->assertSame( $options, $rr->getOptions() );
199 $html = $rr->getRevisionParserOutput()->getText();
201 $this->assertContains( 'page:' . __CLASS__
, $html );
202 $this->assertContains( 'rev:21', $html );
203 $this->assertContains( 'user:Frank', $html );
204 $this->assertContains( 'time:20180101000003', $html );
206 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
209 public function testGetRenderedRevision_master() {
210 $renderer = $this->newRevisionRenderer( 100, true ); // use master
211 $title = $this->getMockTitle( 7, 21 );
213 $rev = new MutableRevisionRecord( $title );
214 $rev->setId( 21 ); // current!
215 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
216 $rev->setTimestamp( '20180101000003' );
219 $text .= "* page:{{PAGENAME}}\n";
220 $text .= "* rev:{{REVISIONID}}\n";
221 $text .= "* user:{{REVISIONUSER}}\n";
222 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
224 $rev->setContent( 'main', new WikitextContent( $text ) );
226 $options = ParserOptions
::newCanonical( 'canonical' );
227 $rr = $renderer->getRenderedRevision( $rev, $options, null, [ 'use-master' => true ] );
229 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
231 $html = $rr->getRevisionParserOutput()->getText();
233 $this->assertContains( 'rev:21', $html );
235 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
238 public function testGetRenderedRevision_old() {
239 $renderer = $this->newRevisionRenderer( 100 );
240 $title = $this->getMockTitle( 7, 21 );
242 $rev = new MutableRevisionRecord( $title );
243 $rev->setId( 11 ); // old!
244 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
245 $rev->setTimestamp( '20180101000003' );
248 $text .= "* page:{{PAGENAME}}\n";
249 $text .= "* rev:{{REVISIONID}}\n";
250 $text .= "* user:{{REVISIONUSER}}\n";
251 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
253 $rev->setContent( 'main', new WikitextContent( $text ) );
255 $options = ParserOptions
::newCanonical( 'canonical' );
256 $rr = $renderer->getRenderedRevision( $rev, $options );
258 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
260 $this->assertSame( $rev, $rr->getRevision() );
261 $this->assertSame( $options, $rr->getOptions() );
263 $html = $rr->getRevisionParserOutput()->getText();
265 $this->assertContains( 'page:' . __CLASS__
, $html );
266 $this->assertContains( 'rev:11', $html );
267 $this->assertContains( 'user:Frank', $html );
268 $this->assertContains( 'time:20180101000003', $html );
270 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
273 public function testGetRenderedRevision_suppressed() {
274 $renderer = $this->newRevisionRenderer( 100 );
275 $title = $this->getMockTitle( 7, 21 );
277 $rev = new MutableRevisionRecord( $title );
278 $rev->setId( 11 ); // old!
279 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
280 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
281 $rev->setTimestamp( '20180101000003' );
284 $text .= "* page:{{PAGENAME}}\n";
285 $text .= "* rev:{{REVISIONID}}\n";
286 $text .= "* user:{{REVISIONUSER}}\n";
287 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
289 $rev->setContent( 'main', new WikitextContent( $text ) );
291 $options = ParserOptions
::newCanonical( 'canonical' );
292 $rr = $renderer->getRenderedRevision( $rev, $options );
294 $this->assertNull( $rr, 'getRenderedRevision' );
297 public function testGetRenderedRevision_privileged() {
298 $renderer = $this->newRevisionRenderer( 100 );
299 $title = $this->getMockTitle( 7, 21 );
301 $rev = new MutableRevisionRecord( $title );
302 $rev->setId( 11 ); // old!
303 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
304 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
305 $rev->setTimestamp( '20180101000003' );
308 $text .= "* page:{{PAGENAME}}\n";
309 $text .= "* rev:{{REVISIONID}}\n";
310 $text .= "* user:{{REVISIONUSER}}\n";
311 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
313 $rev->setContent( 'main', new WikitextContent( $text ) );
315 $options = ParserOptions
::newCanonical( 'canonical' );
316 $sysop = $this->getTestUser( [ 'sysop' ] )->getUser(); // privileged!
317 $rr = $renderer->getRenderedRevision( $rev, $options, $sysop );
319 $this->assertTrue( $rr->isContentDeleted(), 'isContentDeleted' );
321 $this->assertSame( $rev, $rr->getRevision() );
322 $this->assertSame( $options, $rr->getOptions() );
324 $html = $rr->getRevisionParserOutput()->getText();
326 // Suppressed content should be visible for sysops
327 $this->assertContains( 'page:' . __CLASS__
, $html );
328 $this->assertContains( 'rev:11', $html );
329 $this->assertContains( 'user:Frank', $html );
330 $this->assertContains( 'time:20180101000003', $html );
332 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
335 public function testGetRenderedRevision_raw() {
336 $renderer = $this->newRevisionRenderer( 100 );
337 $title = $this->getMockTitle( 7, 21 );
339 $rev = new MutableRevisionRecord( $title );
340 $rev->setId( 11 ); // old!
341 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
342 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
343 $rev->setTimestamp( '20180101000003' );
346 $text .= "* page:{{PAGENAME}}\n";
347 $text .= "* rev:{{REVISIONID}}\n";
348 $text .= "* user:{{REVISIONUSER}}\n";
349 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
351 $rev->setContent( 'main', new WikitextContent( $text ) );
353 $options = ParserOptions
::newCanonical( 'canonical' );
354 $rr = $renderer->getRenderedRevision(
358 [ 'audience' => RevisionRecord
::RAW
]
361 $this->assertTrue( $rr->isContentDeleted(), 'isContentDeleted' );
363 $this->assertSame( $rev, $rr->getRevision() );
364 $this->assertSame( $options, $rr->getOptions() );
366 $html = $rr->getRevisionParserOutput()->getText();
368 // Suppressed content should be visible in raw mode
369 $this->assertContains( 'page:' . __CLASS__
, $html );
370 $this->assertContains( 'rev:11', $html );
371 $this->assertContains( 'user:Frank', $html );
372 $this->assertContains( 'time:20180101000003', $html );
374 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
377 public function testGetRenderedRevision_multi() {
378 $renderer = $this->newRevisionRenderer();
379 $title = $this->getMockTitle( 7, 21 );
381 $rev = new MutableRevisionRecord( $title );
382 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
383 $rev->setTimestamp( '20180101000003' );
385 $rev->setContent( 'main', new WikitextContent( '[[Kittens]]' ) );
386 $rev->setContent( 'aux', new WikitextContent( '[[Goats]]' ) );
388 $rr = $renderer->getRenderedRevision( $rev );
390 $combinedOutput = $rr->getRevisionParserOutput();
391 $mainOutput = $rr->getSlotParserOutput( 'main' );
392 $auxOutput = $rr->getSlotParserOutput( 'aux' );
394 $combinedHtml = $combinedOutput->getText();
395 $mainHtml = $mainOutput->getText();
396 $auxHtml = $auxOutput->getText();
398 $this->assertContains( 'Kittens', $mainHtml );
399 $this->assertContains( 'Goats', $auxHtml );
400 $this->assertNotContains( 'Goats', $mainHtml );
401 $this->assertNotContains( 'Kittens', $auxHtml );
402 $this->assertContains( 'Kittens', $combinedHtml );
403 $this->assertContains( 'Goats', $combinedHtml );
404 $this->assertContains( '>aux<', $combinedHtml, 'slot header' );
405 $this->assertNotContains( '<mw:slotheader', $combinedHtml, 'slot header placeholder' );
407 // make sure output wrapping works right
408 $this->assertContains( 'class="mw-parser-output"', $mainHtml );
409 $this->assertContains( 'class="mw-parser-output"', $auxHtml );
410 $this->assertContains( 'class="mw-parser-output"', $combinedHtml );
412 // there should be only one wrapper div
413 $this->assertSame( 1, preg_match_all( '#class="mw-parser-output"#', $combinedHtml ) );
414 $this->assertNotContains( 'class="mw-parser-output"', $combinedOutput->getRawText() );
416 $combinedLinks = $combinedOutput->getLinks();
417 $mainLinks = $mainOutput->getLinks();
418 $auxLinks = $auxOutput->getLinks();
419 $this->assertTrue( isset( $combinedLinks[NS_MAIN
]['Kittens'] ), 'links from main slot' );
420 $this->assertTrue( isset( $combinedLinks[NS_MAIN
]['Goats'] ), 'links from aux slot' );
421 $this->assertFalse( isset( $mainLinks[NS_MAIN
]['Goats'] ), 'no aux links in main' );
422 $this->assertFalse( isset( $auxLinks[NS_MAIN
]['Kittens'] ), 'no main links in aux' );
425 public function testGetRenderedRevision_noHtml() {
426 /** @var MockObject|Content $mockContent */
427 $mockContent = $this->getMockBuilder( WikitextContent
::class )
428 ->setMethods( [ 'getParserOutput' ] )
429 ->setConstructorArgs( [ 'Whatever' ] )
431 $mockContent->method( 'getParserOutput' )
432 ->willReturnCallback( function ( Title
$title, $revId = null,
433 ParserOptions
$options = null, $generateHtml = true
435 if ( !$generateHtml ) {
436 return new ParserOutput( null );
438 $this->fail( 'Should not be called with $generateHtml == true' );
439 return null; // never happens, make analyzer happy
443 $renderer = $this->newRevisionRenderer();
444 $title = $this->getMockTitle( 7, 21 );
446 $rev = new MutableRevisionRecord( $title );
447 $rev->setContent( 'main', $mockContent );
448 $rev->setContent( 'aux', $mockContent );
450 // NOTE: we are testing the private combineSlotOutput() callback here.
451 $rr = $renderer->getRenderedRevision( $rev );
453 $output = $rr->getSlotParserOutput( 'main', [ 'generate-html' => false ] );
454 $this->assertFalse( $output->hasText(), 'hasText' );
456 $output = $rr->getRevisionParserOutput( [ 'generate-html' => false ] );
457 $this->assertFalse( $output->hasText(), 'hasText' );